home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / COMM / MSDOS-DISK / DOSFS / !DosFS / ReadMe2 < prev    next >
Text File  |  1990-12-19  |  6KB  |  151 lines
  1. > !DosFS.ReadMe2
  2.                 
  3. DOCUMENTATION OF DOSFS-FILER
  4. ----------------------------
  5.  
  6. Author: Rob Schrauwen
  7. Remark: Applies only to Filer2 Version 2.60 or later.
  8.  
  9.  
  10. THE FILER
  11.  
  12. The DosFS-Filer is a program which has two functions. First of all,
  13. it gives access to a filer window when the floppy-drive icon is pressed
  14. and it allows the user to perform some DosFS-specific functions,
  15. such as counting the number of bytes free, changing the volume label (disc
  16. name) etc., when Menu is pressed.
  17. Very early versions of the filer (submitted to various places without
  18. my knowing that) were not able to do anything more.
  19.  
  20. The second function of DosFS-Filer is to provide a front end to the
  21. DosFS filing system. It makes name and file conversions possible.
  22. The transfer icon on the icon bar belongs to this part.
  23.  
  24.  
  25. THE CONVERSION UTILITY
  26.  
  27. The DosFS-Filer, called Filer2 for historical reasons, supports file
  28. conversion from DOS to RISC-OS and back. Instead of copying directly to
  29. and from the DosFS filer window, drop one or more files on the conversion
  30. icon, next to the floppy disc icon. A window is opened and it is possible
  31. to enter various options, but by default the program will try to fill
  32. in the options by itself. To finish, drag the file icon in this window to
  33. the destination.
  34.  
  35. [If the Window manager would send messages through a vector, this extra
  36. step of dragging 'through' the transfer icon, could be omitted.]
  37.  
  38. One can make 4 choices of file name conventions. It is also possible to
  39. let the program make the choices automatically depending on the extension,
  40. see further below.
  41.  
  42.  
  43. NAME CONVERSIONS
  44.  
  45. - The RSDOS (conversion #0) and NoExt (conversion #1) options work as
  46.   expected. #0 uses the official RSDOS naming rules, used to get unique file   names. It has the problem that names can become too long (the filer
  47.   will truncate those names). The NoExt (#1) option just omits the
  48.   extension, but this may result in two files getting the same name.
  49.  
  50. - The C (conversion #2) and TeX (conversion #3) options look for a
  51.   directory to put the files in.
  52.   
  53.   As an example, think of a large number of ".c" and ".h" files for the C
  54.   compiler. These files are copied into the directories C and H,
  55.   respectively, depending on the extension. This is the format required by
  56.   the C compiler. So you don't need to select the ".c" file first, then
  57.   copy, and then do the same with ".h" files.
  58.  
  59.   Warning: when using these conversion options, do not copy
  60.   a file into the directory C itself but to the parent, since otherwise a
  61.   directory C will be created within C. (Just try and see for yourself!)
  62.   Although this does not follow RISC-OS conventions, it is most useful
  63.   since it is likely that one wants to copy ".c" and ".h" files at the
  64.   same time, but their destinations are different.
  65.  
  66. The name "C" is used since the Acorn compilers use this format. "TeX" is
  67. used because Graham Toal's implementation of TeX uses the reversed format,
  68. where the directories are called after the name instead of the extension.
  69.  
  70. In the other direction, from ADFS to DosFS, the effect is similar, but
  71. the RiscOS-Filer will not allow you to make selections in different
  72. subdirectories at the same time.
  73.  
  74. In order to prevent errors, the Filer will cut names that are too long.
  75.  
  76.  
  77. AUTOSELECTION of conversion modes
  78.  
  79. Depending on the extension of the RSDOS file, the program will use
  80. a suitable conversion mode. This can be overruled if required. DosFS-Filer
  81. will look for the existence of system variables of the form DosFS$@Ext_xxx
  82. where xxx is an Dos-extension. These system variables are typically defined
  83. in the !Run file. You can add your own ones and change existing ones. Their
  84. function is best illustrated by some examples:
  85.  
  86. -- Set DosFS$@Ext_ARC DDC 1 B
  87.  
  88. This means that files with extension ARC will get file type DDC (Spark);
  89. name conversion #1 will be used (= omit extension, the name conversions
  90. are numbered from 0 to 3), and  B  indicates binary mode (i.e. do not
  91. change end-of-line characters).
  92.  
  93. -- Set DosFS$@Ext_C FFF 2 A
  94.  
  95. For files with extension "C", use file type FFF (text), name conversion #2
  96. (C-mode);  A  denotes ascii-mode (i.e. change CRLF to LF).
  97.  
  98. Other examples can be found in the !Run file, where several variables
  99. are already set up.
  100.  
  101. Note that if for extension  xxx  no system variable DosFS$@Ext_xxx is
  102. defined, the last selected setting is used, which can be changed by
  103. clicking the options in the conversion window. However, if such a variable
  104. does exist, the program will always use the settings described by that
  105. variable, unless you switch of the Autoselection mode. So if you want
  106. to transfer a C-file using name conversion #1 and the variable prescribes
  107. #2, then clicking on the #1 icon has no effect unless the Autoselection
  108. is switched off.
  109.  
  110. In general, a DosFS$@Ext_xxx system variable (where xxx is an up to
  111. three character sequence) must consist of:
  112. 1) A three-digit hex number, denoting the file type followed by a space;
  113. 2) 0,1,2 or 3, denoting the name conversion number (RSDOS-naming, NoExt,
  114.    C-mode, TeX-mode), followed by a space;
  115. 3) A or B, denoting Ascii or Binary conversion (end-of-line characters
  116.    will be changed (only) with the A option).
  117. It is necessary to use only uppercase letters.
  118.  
  119. The auto selection has no effect in the direction ADFS to DosFS.
  120.  
  121.  
  122. FURTHER OPTIONS in the window
  123.  
  124. If no variable is defined for a certain extension, or when the AutoSelection
  125. mode is switched off, the program will follow the manual selection.
  126.  
  127. - The end-of-line conversion changes CRLF in an RSDOS file to LF;
  128.   in the other direction both CR and LF are expanded into CRLF.
  129.  
  130. - It is possible to change the file type of the ADFS destination files.
  131.   One can only use the 3 digit hex number.
  132.  
  133. - When the 'Prompt for disc insertion' mode is switched on, the user
  134.   is prompted for disc insertions, which is useful for copying directly
  135.   between RSDOS and ADFS floppies in drive :0.
  136.  
  137.  
  138. REMARKS
  139.  
  140. DosFS-Filer does not support formatting discs. There are separate programs
  141. available (not written by me) that can do that.
  142.  
  143. If you think some options are missing, I would like to know. Of course
  144. no-one prevents you from writing your own Filer program interacting
  145. with DosFS. If you make changes to the Filer, please document this carefully
  146. and call it Filer3; Filer2 should alway be retained.
  147.  
  148.  
  149.  
  150. © Rob Schrauwen 1990
  151.